/* Gauge - Performance Measurement Framework for Mobile Platforms
 * Copyright (C) 2013, Juha Hytonen <juha.a.hytonen@gmail.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.gauge;

import android.content.Context;

/**
 * Creates load to stress the system.
 * 
 * Three types of workload are supported: periodic, background and timed.
 * - PERIODIC workloads are executed on given intervals and run at most until
 *   a new instance of the workload is started. A periodic workload might
 *   poll for new e-mails.
 * - BACKGROUND workloads are executed continuously. Their lifespan follows
 *   that of the benchmark. A background workload might play music.
 * - TIMED workloads are executed for a given time. A timed workload might
 *   render a web page.
 */
public interface Workload {
	
	/**
	 * Sets Android context, in which the workload is run.
	 */
	public void SetContext(Context context);
	
	/**
	 * Runs the workload.
	 * 
	 * PERIODIC WORKLOADS
	 * - Run at most until Stop() is called.
	 * BACKGROUND, TIMED WORKLOADS
	 * - Run until Stop() is called.
	 */
	public void Run();
	
	/**
	 * Stops the workload. In all cases prepare for eventual thread termination.
	 * 
	 * PERIODIC WORKLOADS
	 * - Stop workload and prepare for restart. Thread change will occur.
	 * BACKGROUND, TIMED WORKLOADS
	 * - Stop workload and prepare for thread interruption.
	 */
	public void Stop();

}
